Synced solved

Author: Lettify

schemas/function.yaml

@@ -1,5 +1,5 @@
 $schema: https://json-schema.org/draft/2020-12/schema
-$id: /schemas/function
+$id: function.yaml
 title: Function schema
 type: object
 
@@ -26,6 +26,9 @@ $defs:
       name:
         type: string
         description: Name of the function.
+      description:
+        type: string
+        description: Describes the functionality provided by the function.
       pair:
         type: string
         description: Associates this function with another getter or setter function.
@@ -38,56 +41,26 @@ $defs:
           anyOf:
             - type: string
             - const: true
-      meta:
-        $ref: '#/$defs/meta'
-      description:
-        type: string
-        description: Describes the functionality provided by the function.
-      important_notes:
-        type: array
-        description: |
-          A list of important notes about the function.
-          This is a list of things that are important to know about the function, but not
-          necessarily related to the function itself.
-        items:
-          type: string
-      notes:
-        type: array
-        description: List of noteworthy pieces of information for the function.
-        items:
-          type: string
-      preview_images:
-        $ref: '#/$defs/preview_images'
       parameters:
         $ref: '#/$defs/parameters'
       ignore_parameters:
-        type: array
-        description: |
-          A list of parameters to remove from the parameters list.
-          You should only use this for shared functions, for example where the client function is
-          missing a player parameter
-        items:
-          type: string
-          uniqueItems: true
+        $ref: '#/$defs/ignore_parameters'
       returns:
         $ref: '#/$defs/returns'
+      meta:
+        $ref: 'common-defs.yaml#/$defs/meta'
+      notes:
+        $ref: 'common-defs.yaml#/$defs/notes'
+      preview_images:
+        $ref: 'common-defs.yaml#/$defs/preview_images'
       version:
-        description: Version information when the function got added/deprecated/removed.
-        $ref: '#/$defs/version'
+        $ref: 'common-defs.yaml#/$defs/version'
       issues:
-        $ref: '#/$defs/issues'
+        $ref: 'common-defs.yaml#/$defs/issues'
       examples:
-        $ref: '#/$defs/examples'
+        $ref: 'common-defs.yaml#/$defs/examples'
       see_also:
-        type: array
-        description: |
-          A list of other categories for further reading.
-          Every function will implicitly display it's own category in *See Also*, unless you
-          introduce this property, then you have to be explicit about it.
-        items:
-          type: string
-          pattern: "^(category):"
-          uniqueItems: true
+        $ref: 'common-defs.yaml#/$defs/see_also'
 
   oop:
     type: object
@@ -122,31 +95,6 @@ $defs:
             type: string
             description: Name of the constructor.
 
-  meta:
-    type: array
-    description: A list of meta properties about the function and it's documentation.
-    items:
-      type: object
-      properties:
-        needs_checking:
-          type: string
-          description: Describe why the function needs checking by another person. What's problematic?
-
-  preview_images:
-    type: array
-    description: A list of picture assets demonstrating the function.
-    items:
-      type: object
-      required:
-        - path
-      properties:
-        path:
-          type: string
-          description: A relative or repository-absolute path to an asset file.
-        description:
-          type: string
-          description: Brief summary of the content in the picture.
-
   parameters:
     type: array
     description: A list of required and optional parameters for the function.
@@ -171,7 +119,15 @@ $defs:
           description: |
             The default value for this parameter, if none was given in the call to the function.
             This property automatically implicitly marks this parameter as optional.
-
+  ignore_parameters:
+    type: array
+    description: |
+      A list of parameters to remove from the parameters list.
+      You should only use this for shared functions, for example where the client function is
+      missing a player parameter
+    items:
+      type: string
+      uniqueItems: true
   returns:
     type: object
     required:
@@ -194,55 +150,4 @@ $defs:
               description: Type of the return value.
             name:
               type: string
-              description: Name of the return value.
-
-  version:
-    type: object
-    properties:
-      added:
-        type: string
-        description: Version when this item was added to MTA.
-      removed:
-        type: string
-        description: Version when this item was removed from MTA.
-      deprecated:
-        type: string
-        description: Version when this item was deprecated in MTA.
-      replacement:
-        type: string
-        description: An optional replacement for this item.
-
-  issues:
-    type: array
-    description: A list of related issues for this function.
-    items:
-      type: object
-      required:
-        - id
-        - description
-      properties:
-        id:
-          type: integer
-          description: Numeric identifier of the GitHub issue.
-        description:
-          type: string
-          description: Description or summary for this GitHub issue.
-
-  examples:
-    type: array
-    description: A list of source code examples demonstrating the function.
-    items:
-      type: object
-      required:
-        - path
-      properties:
-        path:
-          type: string
-          description: A relative or repository-absolute path to an example source file.
-        description:
-          type: string
-          description: Description for this source code example.
-        append:
-          type: boolean
-          default: false
-          description: If set to true, this example will be appended to the previous example.
+              description: Name of the return value.