Skip to content

Commit 6c8c09f

Browse files
committed
2321: Updated api spec
1 parent a511537 commit 6c8c09f

File tree

2 files changed

+148
-108
lines changed

2 files changed

+148
-108
lines changed

public/api-spec-v2.json

Lines changed: 88 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -623,6 +623,70 @@
623623
"deprecated": false
624624
}
625625
},
626+
"/v2/feed-sources/{id}/config/{name}": {
627+
"get": {
628+
"operationId": "get-v2-feed-source-id-config-name",
629+
"tags": [
630+
"FeedSources"
631+
],
632+
"responses": {
633+
"200": {
634+
"content": {
635+
"application/ld+json": {
636+
"examples": {
637+
"example1": {
638+
"value": [
639+
{
640+
"key": "key1",
641+
"id": "id1",
642+
"value": "value1"
643+
}
644+
]
645+
}
646+
}
647+
}
648+
},
649+
"headers": []
650+
}
651+
},
652+
"summary": "Get config for name from a feed source.",
653+
"description": "Get config for name from a feed source.",
654+
"parameters": [
655+
{
656+
"name": "id",
657+
"in": "path",
658+
"description": "",
659+
"required": true,
660+
"deprecated": false,
661+
"allowEmptyValue": false,
662+
"schema": {
663+
"type": "string",
664+
"format": "ulid",
665+
"pattern": "^[A-Za-z0-9]{26}$"
666+
},
667+
"style": "simple",
668+
"explode": false,
669+
"allowReserved": false
670+
},
671+
{
672+
"name": "name",
673+
"in": "path",
674+
"description": "",
675+
"required": true,
676+
"deprecated": false,
677+
"allowEmptyValue": false,
678+
"schema": {
679+
"type": "string",
680+
"pattern": "^[A-Za-z0-9]*$"
681+
},
682+
"style": "simple",
683+
"explode": false,
684+
"allowReserved": false
685+
}
686+
],
687+
"deprecated": false
688+
}
689+
},
626690
"/v2/feed-sources/{id}/slides": {
627691
"get": {
628692
"operationId": "get-v2-feed-source-slide-id",
@@ -875,70 +939,6 @@
875939
"deprecated": false
876940
}
877941
},
878-
"/v2/feed_sources/{id}/config/{name}": {
879-
"get": {
880-
"operationId": "get-v2-feed-source-id-config-name",
881-
"tags": [
882-
"FeedSources"
883-
],
884-
"responses": {
885-
"200": {
886-
"content": {
887-
"application/ld+json": {
888-
"examples": {
889-
"example1": {
890-
"value": [
891-
{
892-
"key": "key1",
893-
"id": "id1",
894-
"value": "value1"
895-
}
896-
]
897-
}
898-
}
899-
}
900-
},
901-
"headers": []
902-
}
903-
},
904-
"summary": "Get config for name from a feed source.",
905-
"description": "Get config for name from a feed source.",
906-
"parameters": [
907-
{
908-
"name": "id",
909-
"in": "path",
910-
"description": "",
911-
"required": true,
912-
"deprecated": false,
913-
"allowEmptyValue": false,
914-
"schema": {
915-
"type": "string",
916-
"format": "ulid",
917-
"pattern": "^[A-Za-z0-9]{26}$"
918-
},
919-
"style": "simple",
920-
"explode": false,
921-
"allowReserved": false
922-
},
923-
{
924-
"name": "name",
925-
"in": "path",
926-
"description": "",
927-
"required": true,
928-
"deprecated": false,
929-
"allowEmptyValue": false,
930-
"schema": {
931-
"type": "string",
932-
"pattern": "^[A-Za-z0-9]*$"
933-
},
934-
"style": "simple",
935-
"explode": false,
936-
"allowReserved": false
937-
}
938-
],
939-
"deprecated": false
940-
}
941-
},
942942
"/v2/feeds": {
943943
"get": {
944944
"operationId": "get-v2-feeds",
@@ -8144,6 +8144,12 @@
81448144
"feedType": {
81458145
"type": "string"
81468146
},
8147+
"secrets": {
8148+
"type": "array",
8149+
"items": {
8150+
"type": "string"
8151+
}
8152+
},
81478153
"feeds": {
81488154
"type": "array",
81498155
"items": {
@@ -8201,6 +8207,12 @@
82018207
"feedType": {
82028208
"type": "string"
82038209
},
8210+
"secrets": {
8211+
"type": "array",
8212+
"items": {
8213+
"type": "string"
8214+
}
8215+
},
82048216
"feeds": {
82058217
"type": "array",
82068218
"items": {
@@ -8293,6 +8305,12 @@
82938305
"feedType": {
82948306
"type": "string"
82958307
},
8308+
"secrets": {
8309+
"type": "array",
8310+
"items": {
8311+
"type": "string"
8312+
}
8313+
},
82968314
"feeds": {
82978315
"type": "array",
82988316
"items": {
@@ -8463,6 +8481,12 @@
84638481
"feedType": {
84648482
"type": "string"
84658483
},
8484+
"secrets": {
8485+
"type": "array",
8486+
"items": {
8487+
"type": "string"
8488+
}
8489+
},
84668490
"feeds": {
84678491
"type": "array",
84688492
"items": {

public/api-spec-v2.yaml

Lines changed: 60 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -463,6 +463,50 @@ paths:
463463
explode: false
464464
allowReserved: false
465465
deprecated: false
466+
'/v2/feed-sources/{id}/config/{name}':
467+
get:
468+
operationId: get-v2-feed-source-id-config-name
469+
tags:
470+
- FeedSources
471+
responses:
472+
'200':
473+
content:
474+
application/ld+json:
475+
examples:
476+
example1:
477+
value: [{ key: key1, id: id1, value: value1 }]
478+
headers: []
479+
summary: 'Get config for name from a feed source.'
480+
description: 'Get config for name from a feed source.'
481+
parameters:
482+
-
483+
name: id
484+
in: path
485+
description: ''
486+
required: true
487+
deprecated: false
488+
allowEmptyValue: false
489+
schema:
490+
type: string
491+
format: ulid
492+
pattern: '^[A-Za-z0-9]{26}$'
493+
style: simple
494+
explode: false
495+
allowReserved: false
496+
-
497+
name: name
498+
in: path
499+
description: ''
500+
required: true
501+
deprecated: false
502+
allowEmptyValue: false
503+
schema:
504+
type: string
505+
pattern: '^[A-Za-z0-9]*$'
506+
style: simple
507+
explode: false
508+
allowReserved: false
509+
deprecated: false
466510
'/v2/feed-sources/{id}/slides':
467511
get:
468512
operationId: get-v2-feed-source-slide-id
@@ -673,50 +717,6 @@ paths:
673717
explode: false
674718
allowReserved: false
675719
deprecated: false
676-
'/v2/feed_sources/{id}/config/{name}':
677-
get:
678-
operationId: get-v2-feed-source-id-config-name
679-
tags:
680-
- FeedSources
681-
responses:
682-
'200':
683-
content:
684-
application/ld+json:
685-
examples:
686-
example1:
687-
value: [{ key: key1, id: id1, value: value1 }]
688-
headers: []
689-
summary: 'Get config for name from a feed source.'
690-
description: 'Get config for name from a feed source.'
691-
parameters:
692-
-
693-
name: id
694-
in: path
695-
description: ''
696-
required: true
697-
deprecated: false
698-
allowEmptyValue: false
699-
schema:
700-
type: string
701-
format: ulid
702-
pattern: '^[A-Za-z0-9]{26}$'
703-
style: simple
704-
explode: false
705-
allowReserved: false
706-
-
707-
name: name
708-
in: path
709-
description: ''
710-
required: true
711-
deprecated: false
712-
allowEmptyValue: false
713-
schema:
714-
type: string
715-
pattern: '^[A-Za-z0-9]*$'
716-
style: simple
717-
explode: false
718-
allowReserved: false
719-
deprecated: false
720720
/v2/feeds:
721721
get:
722722
operationId: get-v2-feeds
@@ -5766,6 +5766,10 @@ components:
57665766
type: string
57675767
feedType:
57685768
type: string
5769+
secrets:
5770+
type: array
5771+
items:
5772+
type: string
57695773
feeds:
57705774
type: array
57715775
items:
@@ -5806,6 +5810,10 @@ components:
58065810
type: string
58075811
feedType:
58085812
type: string
5813+
secrets:
5814+
type: array
5815+
items:
5816+
type: string
58095817
feeds:
58105818
type: array
58115819
items:
@@ -5869,6 +5877,10 @@ components:
58695877
type: string
58705878
feedType:
58715879
type: string
5880+
secrets:
5881+
type: array
5882+
items:
5883+
type: string
58725884
feeds:
58735885
type: array
58745886
items:
@@ -5985,6 +5997,10 @@ components:
59855997
type: string
59865998
feedType:
59875999
type: string
6000+
secrets:
6001+
type: array
6002+
items:
6003+
type: string
59886004
feeds:
59896005
type: array
59906006
items:

0 commit comments

Comments
 (0)