Skip to content

Commit f0fc434

Browse files
committed
codelists: removed experimental tag from endpoint
After thought, I decided to remove the "experimental" tag from the codelist. Reasoning follows: - this was imported to match the codelist used in commongrants, which has a different governance model - there are neither any current api endpoints nor any theoretical ones that people want to implement that would benefit from this - HSDS' profile mechanism is more appropriate for adding experimental features - the governance model of HSDS means that any experimental API endpoint added would need a MAJOR upgrade to remove it
1 parent 91374b7 commit f0fc434

3 files changed

Lines changed: 0 additions & 17 deletions

File tree

docs/extras/openapi30.json

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,6 @@
2525
"description": "This URI points to the codelist file used to define the codes in HSDS which are then used to define this tag. The OpenAPI Tag objects are used to implement the codelist, whereas the canonical definition is in the codelist. If there are any discrepancies between the description of this OpenAPI Tag and the codelist, the codelist takes priority.",
2626
"url": "https://docs.openreferral.org/en/latest/hsds/codelists.html#api-endpoint-requirement"
2727
}
28-
},
29-
{
30-
"name": "experimental",
31-
"description": "This endpoint is experimental and is included for the purposes of testing and feedback from the community. It is considered OPTIONAL by the HSDS API Specification.",
32-
"externalDocs": {
33-
"description": "This URI points to the codelist file used to define the codes in HSDS which are then used to define this tag. The OpenAPI Tag objects are used to implement the codelist, whereas the canonical definition is in the codelist. If there are any discrepancies between the description of this OpenAPI Tag and the codelist, the codelist takes priority.",
34-
"url": "https://docs.openreferral.org/en/latest/hsds/codelists.html#api-endpoint-requirement"
35-
}
3628
}
3729
],
3830
"paths": {
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
Code,Title,Description
22
"required","Required","This endpoint is REQUIRED by the HSDS API Specification"
33
"optional","Optional","This endpoint is OPTIONAL in the HSDS API Specification"
4-
"experimental","Experimental","This endpoint is experimental and is included for the purposes of testing and feedback from the community. It is considered OPTIONAL by the HSDS API Specification."

schema/openapi.json

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,6 @@
3232
"description": "This URI points to the codelist file used to define the codes in HSDS which are then used to define this tag. The OpenAPI Tag objects are used to implement the codelist, whereas the canonical definition is in the codelist. If there are any discrepancies between the description of this OpenAPI Tag and the codelist, the codelist takes priority.",
3333
"url": "https://docs.openreferral.org/en/latest/hsds/codelists.html#api-endpoint-requirement"
3434
}
35-
},
36-
{
37-
"name": "experimental",
38-
"description": "This endpoint is experimental and is included for the purposes of testing and feedback from the community. It is considered OPTIONAL by the HSDS API Specification.",
39-
"externalDocs": {
40-
"description": "This URI points to the codelist file used to define the codes in HSDS which are then used to define this tag. The OpenAPI Tag objects are used to implement the codelist, whereas the canonical definition is in the codelist. If there are any discrepancies between the description of this OpenAPI Tag and the codelist, the codelist takes priority.",
41-
"url": "https://docs.openreferral.org/en/latest/hsds/codelists.html#api-endpoint-requirement"
42-
}
4335
}
4436
],
4537
"paths": {

0 commit comments

Comments
 (0)