sysmocom
/
asterisk
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ari-stubs: Fix broken documentation anchors 

All of the links that reference page anchors with capital letters in
the ids (#Something) have been changed to lower case to match the
anchors that are generated by mkdocs.
This commit is contained in:
George Joseph 2023-09-05 09:51:19 -06:00
parent 468df4a12d
commit 8ce313c5b3
4 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
rest-api-templates/api.wiki.mustache
View File

@ -5,7 +5,7 @@
|:------ |:------------------------------------ |:------------ |:------- |
{{#apis}}
{{#operations}}
| {{http_method}} | [{{wiki_path}}](#{{nickname}}) | {{#response_class}}{{#is_primitive}}{{name}}{{/is_primitive}}{{^is_primitive}}[{{wiki_name}}]({{wiki_prefix}}_Asterisk_REST_Data_Models#{{lc_singular_name}}){{/is_primitive}}{{/response_class}} | {{{summary}}} |
| {{http_method}} | [{{wiki_path}}](#{{nickname}}) | {{#response_class}}{{#is_primitive}}{{name}}{{/is_primitive}}{{^is_primitive}}[{{wiki_name}}]({{wiki_prefix}}Asterisk_REST_Data_Models#{{lc_singular_name}}){{/is_primitive}}{{/response_class}} | {{{summary}}} |
{{/operations}}
{{/apis}}
{{#apis}}

2
rest-api-templates/make_ari_stubs.py
View File

@ -77,7 +77,7 @@ def main(argv):
RESOURCES_TRANSFORMS = [
Transform(rel('models.wiki.mustache'),
'%s/_Asterisk_REST_Data_Models.md' % args.dest_dir),
'%s/Asterisk_REST_Data_Models.md' % args.dest_dir),
Transform(rel('ari.make.mustache'), 'res/ari.make'),
Transform(rel('ari_model_validators.h.mustache'),
'res/ari/ari_model_validators.h'),

4
rest-api-templates/models.wiki.mustache
View File

@ -6,8 +6,8 @@ title: Asterisk REST Data Models
{{#api_declaration}}
{{#models}}
## {{id}}
{{#extends}}Base type: [{{extends}}](#{{extends}}){{/extends}}
{{#has_subtypes}}Subtypes:{{#all_subtypes}} [{{id}}](#{{id}}){{/all_subtypes}}{{/has_subtypes}}
{{#extends}}Base type: [{{extends}}](#{{extends_lc}}){{/extends}}
{{#has_subtypes}}Subtypes:{{#all_subtypes}} [{{id}}](#{{id_lc}}){{/all_subtypes}}{{/has_subtypes}}
### Model
``` javascript title="{{id}}" linenums="1"
{{{model_json}}}

5
rest-api-templates/swagger_model.py
View File

@ -501,6 +501,7 @@ class Model(Stringify):
def __init__(self):
self.id = None
self.id_lc = None
self.subtypes = []
self.__subtype_types = []
self.notes = None
@ -514,6 +515,7 @@ class Model(Stringify):
validate_required_fields(model_json, self.required_fields, context)
# The duplication of the model's id is required by the Swagger spec.
self.id = model_json.get('id')
self.id_lc = self.id.lower()
if id != self.id:
raise SwaggerError("Model id doesn't match name", context)
self.subtypes = model_json.get('subTypes') or []
@ -551,6 +553,9 @@ class Model(Stringify):
def extends(self):
return self.__extends_type and self.__extends_type.id
def extends_lc(self):
return self.__extends_type and self.__extends_type.id_lc
def set_extends_type(self, extends_type):
self.__extends_type = extends_type