mirror of
				https://codeberg.org/yeentown/barkey.git
				synced 2025-11-04 07:24:13 +00:00 
			
		
		
		
	✌️
This commit is contained in:
		
							parent
							
								
									42dad3873f
								
							
						
					
					
						commit
						446b6a4f6b
					
				
					 3 changed files with 38 additions and 5 deletions
				
			
		
							
								
								
									
										32
									
								
								src/web/docs/api/endpoints/posts/timeline.yaml
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										32
									
								
								src/web/docs/api/endpoints/posts/timeline.yaml
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
				
			
			@ -0,0 +1,32 @@
 | 
			
		|||
endpoint: "posts/timeline"
 | 
			
		||||
 | 
			
		||||
desc:
 | 
			
		||||
  ja: "タイムラインを取得します。"
 | 
			
		||||
  en: "Get your timeline."
 | 
			
		||||
 | 
			
		||||
params:
 | 
			
		||||
  - name: "limit"
 | 
			
		||||
    type: "number"
 | 
			
		||||
    optional: true
 | 
			
		||||
    desc:
 | 
			
		||||
      ja: "取得する最大の数"
 | 
			
		||||
  - name: "since_id"
 | 
			
		||||
    type: "id(Post)"
 | 
			
		||||
    optional: true
 | 
			
		||||
    desc:
 | 
			
		||||
      ja: "指定すると、この投稿を基点としてより新しい投稿を取得します"
 | 
			
		||||
  - name: "max_id"
 | 
			
		||||
    type: "id(Post)"
 | 
			
		||||
    optional: true
 | 
			
		||||
    desc:
 | 
			
		||||
      ja: "指定すると、この投稿を基点としてより古い投稿を取得します"
 | 
			
		||||
  - name: "since_date"
 | 
			
		||||
    type: "number"
 | 
			
		||||
    optional: true
 | 
			
		||||
    desc:
 | 
			
		||||
      ja: "指定した時間を基点としてより新しい投稿を取得します。数値は、1970 年 1 月 1 日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。"
 | 
			
		||||
  - name: "max_date"
 | 
			
		||||
    type: "number"
 | 
			
		||||
    optional: true
 | 
			
		||||
    desc:
 | 
			
		||||
      ja: "指定した時間を基点としてより古い投稿を取得します。数値は、1970 年 1 月 1 日 00:00:00 UTC から指定した日時までの経過時間をミリ秒単位で表します。"
 | 
			
		||||
| 
						 | 
				
			
			@ -21,6 +21,7 @@ block main
 | 
			
		|||
					h3= paramDef.name
 | 
			
		||||
					+propTable(paramDef.params)
 | 
			
		||||
 | 
			
		||||
	section
 | 
			
		||||
		h2 Response
 | 
			
		||||
		+propTable(res)
 | 
			
		||||
	if res
 | 
			
		||||
		section
 | 
			
		||||
			h2 Response
 | 
			
		||||
			+propTable(res)
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -106,8 +106,8 @@ gulp.task('doc:api:endpoints', () => {
 | 
			
		|||
				desc: ep.desc,
 | 
			
		||||
				params: sortParams(ep.params.map(p => parseParam(p))),
 | 
			
		||||
				paramDefs: extractDefs(ep.params),
 | 
			
		||||
				res: sortParams(ep.res.map(p => parseParam(p))),
 | 
			
		||||
				resDefs: extractDefs(ep.res),
 | 
			
		||||
				res: ep.res ? sortParams(ep.res.map(p => parseParam(p))) : null,
 | 
			
		||||
				resDefs: ep.res ? extractDefs(ep.res) : null,
 | 
			
		||||
			};
 | 
			
		||||
			langs.forEach(lang => {
 | 
			
		||||
				pug.renderFile('./src/web/docs/api/endpoints/view.pug', Object.assign({}, vars, {
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		
		Reference in a new issue