Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

CustomFormatApi.get_custom_format_schema returns None #36

Open
Callum027 opened this issue Aug 30, 2023 · 2 comments
Open

CustomFormatApi.get_custom_format_schema returns None #36

Callum027 opened this issue Aug 30, 2023 · 2 comments

Comments

@Callum027
Copy link

I am unable to retrieve and use the schema for custom format specifications (conditions), because the API function for that purpose (CustomFormatApi.get_custom_format_schema) returns None instead of the schema structure.

Requesting GET /api/v3/customformat/schema manually returns the schema for all types of custom format specifications:

[
  {
    "implementation": "ReleaseTitleSpecification",
    "implementationName": "Release Title",
    "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
    "negate": false,
    "required": false,
    "fields": [
      {
        "order": 0,
        "name": "value",
        "label": "Regular Expression",
        "helpText": "Custom Format RegEx is Case Insensitive",
        "type": "textbox",
        "advanced": false
      }
    ],
    "presets": [
      {
        "name": "x264",
        "implementation": "ReleaseTitleSpecification",
        "implementationName": "Release Title",
        "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
        "negate": false,
        "required": false,
        "fields": [
          {
            "order": 0,
            "name": "value",
            "label": "Regular Expression",
            "helpText": "Custom Format RegEx is Case Insensitive",
            "value": "(x|h)\\.?264",
            "type": "textbox",
            "advanced": false
          }
        ]
      },
      {
        "name": "x265",
        "implementation": "ReleaseTitleSpecification",
        "implementationName": "Release Title",
        "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
        "negate": false,
        "required": false,
        "fields": [
          {
            "order": 0,
            "name": "value",
            "label": "Regular Expression",
            "helpText": "Custom Format RegEx is Case Insensitive",
            "value": "(((x|h)\\.?265)|(HEVC))",
            "type": "textbox",
            "advanced": false
          }
        ]
      },
      {
        "name": "Simple Hardcoded Subs",
        "implementation": "ReleaseTitleSpecification",
        "implementationName": "Release Title",
        "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
        "negate": false,
        "required": false,
        "fields": [
          {
            "order": 0,
            "name": "value",
            "label": "Regular Expression",
            "helpText": "Custom Format RegEx is Case Insensitive",
            "value": "subs?",
            "type": "textbox",
            "advanced": false
          }
        ]
      },
      {
        "name": "Hardcoded Subs",
        "implementation": "ReleaseTitleSpecification",
        "implementationName": "Release Title",
        "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
        "negate": false,
        "required": false,
        "fields": [
          {
            "order": 0,
            "name": "value",
            "label": "Regular Expression",
            "helpText": "Custom Format RegEx is Case Insensitive",
            "value": "\\b(?<hcsub>(\\w+SUBS?)\\b)|(?<hc>(HC|SUBBED))\\b",
            "type": "textbox",
            "advanced": false
          }
        ]
      },
      {
        "name": "Surround Sound",
        "implementation": "ReleaseTitleSpecification",
        "implementationName": "Release Title",
        "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
        "negate": false,
        "required": false,
        "fields": [
          {
            "order": 0,
            "name": "value",
            "label": "Regular Expression",
            "helpText": "Custom Format RegEx is Case Insensitive",
            "value": "DTS.?(HD|ES|X(?!\\D))|TRUEHD|ATMOS|DD(\\+|P).?([5-9])|EAC3.?([5-9])",
            "type": "textbox",
            "advanced": false
          }
        ]
      },
      {
        "name": "Preferred Words",
        "implementation": "ReleaseTitleSpecification",
        "implementationName": "Release Title",
        "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
        "negate": false,
        "required": false,
        "fields": [
          {
            "order": 0,
            "name": "value",
            "label": "Regular Expression",
            "helpText": "Custom Format RegEx is Case Insensitive",
            "value": "\\b(SPARKS|Framestor)\\b",
            "type": "textbox",
            "advanced": false
          }
        ]
      },
      {
        "name": "Hello: Hello",
        "implementation": "ReleaseTitleSpecification",
        "implementationName": "Release Title",
        "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
        "negate": false,
        "required": false,
        "fields": [
          {
            "order": 0,
            "name": "value",
            "label": "Regular Expression",
            "helpText": "Custom Format RegEx is Case Insensitive",
            "value": "Hello",
            "type": "textbox",
            "advanced": false
          }
        ]
      }
    ]
  },
  {
    "implementation": "EditionSpecification",
    "implementationName": "Edition",
    "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
    "negate": false,
    "required": false,
    "fields": [
      {
        "order": 0,
        "name": "value",
        "label": "Regular Expression",
        "helpText": "Custom Format RegEx is Case Insensitive",
        "type": "textbox",
        "advanced": false
      }
    ],
    "presets": [
      {
        "name": "Hello2: Hello2",
        "implementation": "EditionSpecification",
        "implementationName": "Edition",
        "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
        "negate": false,
        "required": false,
        "fields": [
          {
            "order": 0,
            "name": "value",
            "label": "Regular Expression",
            "helpText": "Custom Format RegEx is Case Insensitive",
            "value": "Hello2",
            "type": "textbox",
            "advanced": false
          }
        ]
      }
    ]
  },
  {
    "implementation": "LanguageSpecification",
    "implementationName": "Language",
    "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
    "negate": false,
    "required": false,
    "fields": [
      {
        "order": 0,
        "name": "value",
        "label": "Language",
        "value": 0,
        "type": "select",
        "advanced": false,
        "selectOptions": [
          {
            "value": -1,
            "name": "Any",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": -2,
            "name": "Original",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 0,
            "name": "Unknown",
            "order": 0,
            "dividerAfter": true
          },
          {
            "value": 31,
            "name": "Arabic",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 34,
            "name": "Bengali",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 41,
            "name": "Bosnian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 29,
            "name": "Bulgarian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 38,
            "name": "Catalan",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 10,
            "name": "Chinese",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 39,
            "name": "Croatian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 25,
            "name": "Czech",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 6,
            "name": "Danish",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 7,
            "name": "Dutch",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 1,
            "name": "English",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 42,
            "name": "Estonian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 16,
            "name": "Finnish",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 19,
            "name": "Flemish",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 2,
            "name": "French",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 4,
            "name": "German",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 20,
            "name": "Greek",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 23,
            "name": "Hebrew",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 26,
            "name": "Hindi",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 22,
            "name": "Hungarian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 9,
            "name": "Icelandic",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 44,
            "name": "Indonesian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 5,
            "name": "Italian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 8,
            "name": "Japanese",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 21,
            "name": "Korean",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 36,
            "name": "Latvian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 24,
            "name": "Lithuanian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 15,
            "name": "Norwegian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 33,
            "name": "Persian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 12,
            "name": "Polish",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 18,
            "name": "Portuguese",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 30,
            "name": "Portuguese (Brazil)",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 27,
            "name": "Romanian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 11,
            "name": "Russian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 40,
            "name": "Serbian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 35,
            "name": "Slovak",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 3,
            "name": "Spanish",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 37,
            "name": "Spanish (Latino)",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 14,
            "name": "Swedish",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 43,
            "name": "Tamil",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 45,
            "name": "Telugu",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 28,
            "name": "Thai",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 17,
            "name": "Turkish",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 32,
            "name": "Ukrainian",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 13,
            "name": "Vietnamese",
            "order": 0,
            "dividerAfter": false
          }
        ]
      }
    ],
    "presets": []
  },
  {
    "implementation": "IndexerFlagSpecification",
    "implementationName": "Indexer Flag",
    "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
    "negate": false,
    "required": false,
    "fields": [
      {
        "order": 0,
        "name": "value",
        "label": "Flag",
        "value": 0,
        "type": "select",
        "advanced": false,
        "selectOptions": [
          {
            "value": 1,
            "name": "G Freeleech",
            "order": 1,
            "dividerAfter": false
          },
          {
            "value": 2,
            "name": "G Halfleech",
            "order": 2,
            "dividerAfter": false
          },
          {
            "value": 4,
            "name": "G DoubleUpload",
            "order": 4,
            "dividerAfter": false
          },
          {
            "value": 8,
            "name": "PTP Golden",
            "order": 8,
            "dividerAfter": false
          },
          {
            "value": 16,
            "name": "PTP Approved",
            "order": 16,
            "dividerAfter": false
          },
          {
            "value": 32,
            "name": "HDB Internal",
            "order": 32,
            "dividerAfter": false
          },
          {
            "value": 64,
            "name": "AHD Internal",
            "order": 64,
            "dividerAfter": false
          },
          {
            "value": 128,
            "name": "G Scene",
            "order": 128,
            "dividerAfter": false
          },
          {
            "value": 256,
            "name": "G Freeleech75",
            "order": 256,
            "dividerAfter": false
          },
          {
            "value": 512,
            "name": "G Freeleech25",
            "order": 512,
            "dividerAfter": false
          },
          {
            "value": 1024,
            "name": "AHD UserRelease",
            "order": 1024,
            "dividerAfter": false
          }
        ]
      }
    ],
    "presets": []
  },
  {
    "implementation": "SourceSpecification",
    "implementationName": "Source",
    "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
    "negate": false,
    "required": false,
    "fields": [
      {
        "order": 0,
        "name": "value",
        "label": "Source",
        "value": 0,
        "type": "select",
        "advanced": false,
        "selectOptions": [
          {
            "value": 0,
            "name": "UNKNOWN",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 1,
            "name": "CAM",
            "order": 1,
            "dividerAfter": false
          },
          {
            "value": 2,
            "name": "TELESYNC",
            "order": 2,
            "dividerAfter": false
          },
          {
            "value": 3,
            "name": "TELECINE",
            "order": 3,
            "dividerAfter": false
          },
          {
            "value": 4,
            "name": "WORKPRINT",
            "order": 4,
            "dividerAfter": false
          },
          {
            "value": 5,
            "name": "DVD",
            "order": 5,
            "dividerAfter": false
          },
          {
            "value": 6,
            "name": "TV",
            "order": 6,
            "dividerAfter": false
          },
          {
            "value": 7,
            "name": "WEBDL",
            "order": 7,
            "dividerAfter": false
          },
          {
            "value": 8,
            "name": "WEBRIP",
            "order": 8,
            "dividerAfter": false
          },
          {
            "value": 9,
            "name": "BLURAY",
            "order": 9,
            "dividerAfter": false
          }
        ]
      }
    ],
    "presets": []
  },
  {
    "implementation": "ResolutionSpecification",
    "implementationName": "Resolution",
    "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
    "negate": false,
    "required": false,
    "fields": [
      {
        "order": 0,
        "name": "value",
        "label": "Resolution",
        "value": 0,
        "type": "select",
        "advanced": false,
        "selectOptions": [
          {
            "value": 0,
            "name": "Unknown",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 360,
            "name": "R360p",
            "order": 360,
            "dividerAfter": false
          },
          {
            "value": 480,
            "name": "R480p",
            "order": 480,
            "dividerAfter": false
          },
          {
            "value": 540,
            "name": "R540p",
            "order": 540,
            "dividerAfter": false
          },
          {
            "value": 576,
            "name": "R576p",
            "order": 576,
            "dividerAfter": false
          },
          {
            "value": 720,
            "name": "R720p",
            "order": 720,
            "dividerAfter": false
          },
          {
            "value": 1080,
            "name": "R1080p",
            "order": 1080,
            "dividerAfter": false
          },
          {
            "value": 2160,
            "name": "R2160p",
            "order": 2160,
            "dividerAfter": false
          }
        ]
      }
    ],
    "presets": []
  },
  {
    "implementation": "QualityModifierSpecification",
    "implementationName": "Quality Modifier",
    "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
    "negate": false,
    "required": false,
    "fields": [
      {
        "order": 0,
        "name": "value",
        "label": "Quality Modifier",
        "value": 0,
        "type": "select",
        "advanced": false,
        "selectOptions": [
          {
            "value": 0,
            "name": "NONE",
            "order": 0,
            "dividerAfter": false
          },
          {
            "value": 1,
            "name": "REGIONAL",
            "order": 1,
            "dividerAfter": false
          },
          {
            "value": 2,
            "name": "SCREENER",
            "order": 2,
            "dividerAfter": false
          },
          {
            "value": 3,
            "name": "RAWHD",
            "order": 3,
            "dividerAfter": false
          },
          {
            "value": 4,
            "name": "BRDISK",
            "order": 4,
            "dividerAfter": false
          },
          {
            "value": 5,
            "name": "REMUX",
            "order": 5,
            "dividerAfter": false
          }
        ]
      }
    ],
    "presets": []
  },
  {
    "implementation": "SizeSpecification",
    "implementationName": "Size",
    "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
    "negate": false,
    "required": false,
    "fields": [
      {
        "order": 0,
        "name": "min",
        "label": "Minimum Size",
        "unit": "GB",
        "helpText": "Release must be greater than this size",
        "value": 0,
        "type": "number",
        "advanced": false
      },
      {
        "order": 1,
        "name": "max",
        "label": "Maximum Size",
        "unit": "GB",
        "helpText": "Release must be less than or equal to this size",
        "value": 0,
        "type": "number",
        "advanced": false
      }
    ],
    "presets": []
  },
  {
    "implementation": "ReleaseGroupSpecification",
    "implementationName": "Release Group",
    "infoLink": "https://wiki.servarr.com/radarr/settings#custom-formats-2",
    "negate": false,
    "required": false,
    "fields": [
      {
        "order": 0,
        "name": "value",
        "label": "Regular Expression",
        "helpText": "Custom Format RegEx is Case Insensitive",
        "type": "textbox",
        "advanced": false
      }
    ],
    "presets": []
  }
]
@Fuochi
Copy link
Contributor

Fuochi commented Sep 1, 2023

Hi @Callum027,
Thanks for pointing this out. I am aware of this behavior, and I already edited sonarr-py to change the return type (method will change to list_custom_format_schema) but I haven't propagated the feature on other SDKs yet.
I'll try to find some time to do it soon.

The problem lies in the radarr source code since they're not specifying the return type of api it the swagger file

Fuochi added a commit to devopsarr/sdk-generator that referenced this issue Sep 12, 2023
@Fuochi
feat(devopsarr/radarr-py#36): add cf and at schema return type
54ace05
devopsarr bot added a commit to devopsarr/radarr-go that referenced this issue Sep 12, 2023
@devopsarr
feat(devopsarr/radarr-py#36): add cf and at schema return type
89f4db4
devopsarr bot added a commit that referenced this issue Sep 12, 2023
@devopsarr
feat(#36): add cf and at schema return type
5467546
Fuochi added a commit that referenced this issue Sep 12, 2023
@Fuochi
Merge pull request #38 from devopsarr/feature/code-generation
6bc2c88 
feat(#36): add cf and at schema return type
@devopsarr devopsarr bot mentioned this issue Sep 12, 2023
Merged
Fuochi added a commit to devopsarr/sdk-generator that referenced this issue Sep 12, 2023
@Fuochi
Merge pull request #306 from devopsarr/feature/devopsarr/radarr-py#36
adb8ba0 
feat(devopsarr/radarr-py#36): add cf and at schema return type
devopsarr bot added a commit to devopsarr/radarr-go that referenced this issue Sep 12, 2023
@devopsarr
Merge pull request #33 from devopsarr/feature/code-generation
3b1da7d 
feat(devopsarr/radarr-py#36): add cf and at schema return type
@devopsarr devopsarr bot mentioned this issue Sep 12, 2023
Merged
@Fuochi
Copy link
Contributor

Fuochi commented Sep 12, 2023

Hi @Callum027,
Could you please have a look at v0.4.0 and let me know if it works as expected?

@Callum027 Callum027 mentioned this issue Nov 9, 2023
Open
@devopsarr devopsarr bot mentioned this issue Feb 19, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Callum027 @Fuochi