Skip to content

Commit

Permalink
Merge pull request #110 from redmitry/uri-template
Browse files Browse the repository at this point in the history
for templates the format must be "uri-template".
  • Loading branch information
costero-e authored Oct 8, 2024
2 parents 7e98b1e + 1d4730a commit 5ea17fb
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions framework/json/configuration/beaconMapSchema.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
},
"filteringTermsUrl": {
"description": "Optional. Returns the list of filtering terms that could be applied to this entry type. It is added here for convenience of the Beacon clients, so they don't need to parse the OpenAPI endpoints definition to get that endpoint. Also, in very simple Beacons, that endpoint could be the one of the few implemented, together with \u00b4rootUrl` and \u00b4singleEntryUrl`, in which case the whole map of endpoints is found in the current Map.",
"format": "uri",
"format": "uri-template",
"type": "string"
},
"openAPIEndpointsDefinition": {
Expand All @@ -32,7 +32,7 @@
},
"singleEntryUrl": {
"description": "Optional, but recommended. Returns only one instance of this entry, identified by an `id`. It is added here for convenience of the Beacon clients, so they don't need to parse the OpenAPI endpoints definition to get that base endpoint. Also, in very simple Beacons, that endpoint could be the only one implemented, together with \u00b4rootUrl`, in which case the whole map of endpoints is found in the current Map.",
"format": "uri",
"format": "uri-template",
"type": "string"
}
},
Expand All @@ -50,7 +50,7 @@
},
"url": {
"description": "Endpoint URL",
"format": "uri",
"format": "uri-template",
"type": "string"
}
},
Expand Down
6 changes: 3 additions & 3 deletions framework/src/configuration/beaconMapSchema.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ definitions:
be the only one implemented, together with ´rootUrl`, in which case the
whole map of endpoints is found in the current Map.
type: string
format: uri
format: uri-template
filteringTermsUrl:
description: Optional. Returns the list of filtering terms that could be applied
to this entry type. It is added here for convenience of the Beacon clients,
Expand All @@ -55,7 +55,7 @@ definitions:
the few implemented, together with ´rootUrl` and ´singleEntryUrl`, in which
case the whole map of endpoints is found in the current Map.
type: string
format: uri
format: uri-template
endpoints:
description: Optional. A list describing additional endpoints implemented
by this Beacon instance for that entry type. Additional details on the endpoint
Expand All @@ -74,7 +74,7 @@ definitions:
url:
description: Endpoint URL
type: string
format: uri
format: uri-template
returnedEntryType:
description: Which entry type is returned by querying this endpoint. It MUST
match one of the entry types defined in the Beacon configuration file (`beaconConfiguration.json`).
Expand Down

0 comments on commit 5ea17fb

Please sign in to comment.