https://shields.io/assets/js/6c6fcaea.9d30347a.js

1"use strict";(self.webpackChunkshields_io=self.webpackChunkshields_io||[]).push([[1440],{94151(e,s,l){l.r(s),l.d(s,{contentTitle:()=>n,default:()=>d,frontMatter:()=>r,metadata:()=>t,toc:()=>a});const t=JSON.parse('{"type":"api","id":"cocoapods-doc-percentage","title":"Cocoapods doc percentage","description":"","slug":"/cocoapods-doc-percentage","frontMatter":{},"api":{"parameters":[{"name":"spec","in":"path","required":true,"schema":{"type":"string"},"example":"AFNetworking"},{"name":"style","in":"query","required":false,"description":"If not specified, the default style for this badge is \\"flat\\".","schema":{"type":"string","enum":["flat","flat-square","plastic","for-the-badge","social"]},"example":"flat"},{"name":"logo","in":"query","required":false,"description":"Icon slug from simple-icons. You can click the icon title on <a href=\\"https://simpleicons.org/\\" rel=\\"noopener noreferrer\\" target=\\"_blank\\">simple-icons</a> to copy the slug or they can be found in the <a href=\\"https://github.com/simple-icons/simple-icons/blob/master/slugs.md\\">slugs.md file</a> in the simple-icons repository. <a href=\\"/docs/logos\\">Further info</a>.","schema":{"type":"string"},"example":"appveyor"},{"name":"logoColor","in":"query","required":false,"description":"The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.","schema":{"type":"string"},"example":"violet"},{"name":"logoSize","in":"query","required":false,"description":"Make icons adaptively resize by setting `auto`. Useful for some wider logos like `amd` and `amg`. Supported for simple-icons logos but not for custom logos.","schema":{"type":"string"},"example":"auto"},{"name":"label","in":"query","required":false,"description":"Override the default left-hand-side text (<a href=\\"https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding\\">URL-Encoding</a> needed for spaces or special characters!)","schema":{"type":"string"},"example":"healthiness"},{"name":"labelColor","in":"query","required":false,"description":"Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).","schema":{"type":"string"},"example":"abcdef"},{"name":"color","in":"query","required":false,"description":"Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).","schema":{"type":"string"},"example":"fedcba"},{"name":"cacheSeconds","in":"query","required":false,"description":"HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).","schema":{"type":"string"},"example":"3600"},{"name":"link","in":"query","required":false,"description":"Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an `<object>` HTML tag, but not an `<img>` tag or a markup language.","style":"form","explode":true,"schema":{"type":"array","maxItems":2,"items":{"type":"string"}}}],"x-code-samples":[{"lang":"URL","label":"URL","source":"$url"},{"lang":"Markdown","label":"Markdown","source":"![Cocoapods doc percentage]($url)"},{"lang":"reStructuredText","label":"rSt","source":".. image:: $url\\n   :alt: Cocoapods doc percentage"},{"lang":"AsciiDoc","label":"AsciiDoc","source":"image:$url[Cocoapods doc percentage]"},{"lang":"HTML","label":"HTML","source":"<img alt=\\"Cocoapods doc percentage\\" src=\\"$url\\">"}],"description":"Cocoapods doc percentage","method":"get","path":"/cocoapods/metrics/doc-percent/{spec}","info":{"version":"1.0.0","title":"Analysis","license":{"name":"CC0"}},"postman":{"name":"Cocoapods doc percentage","description":{"type":"text/plain"},"url":{"path":["cocoapods","metrics","doc-percent",":spec"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"If not specified, the default style for this badge is \\"flat\\".","type":"text/plain"},"key":"style","value":"<string>"},{"disabled":false,"description":{"content":"Icon slug from simple-icons. You can click the icon title on <a href=\\"https://simpleicons.org/\\" rel=\\"noopener noreferrer\\" target=\\"_blank\\">simple-icons</a> to copy the slug or they can be found in the <a href=\\"https://github.com/simple-icons/simple-icons/blob/master/slugs.md\\">slugs.md file</a> in the simple-icons repository. <a href=\\"/docs/logos\\">Further info</a>.","type":"text/plain"},"key":"logo","value":"<string>"},{"disabled":false,"description":{"content":"The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.","type":"text/plain"},"key":"logoColor","value":"<string>"},{"disabled":false,"description":{"content":"Make icons adaptively resize by setting `auto`. Useful for some wider logos like `amd` and `amg`. Supported for simple-icons logos but not for custom logos.","type":"text/plain"},"key":"logoSize","value":"<string>"},{"disabled":false,"description":{"content":"Override the default left-hand-side text (<a href=\\"https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding\\">URL-Encoding</a> needed for spaces or special characters!)","type":"text/plain"},"key":"label","value":"<string>"}

1,{"disabled":false,"description":{"content":"Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).","type":"text/plain"},"key":"labelColor","value":"<string>"},{"disabled":false,"description":{"content":"Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).","type":"text/plain"},"key":"color","value":"<string>"},{"disabled":false,"description":{"content":"HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).","type":"text/plain"},"key":"cacheSeconds","value":"<string>"},{"disabled":false,"description":{"content":"Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an `<object>` HTML tag, but not an `<img>` tag or a markup language.","type":"text/plain"},"key":"link","value":"<string>"},{"disabled":false,"description":{"content":"Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an `<object>` HTML tag, but not an `<img>` tag or a markup language.","type":"text/plain"},"key":"link","value":"<string>"}],"variable":[{"disabled":false,"description":{"content":"(Required) ","type":"text/plain"},"type":"any","value":"<string>","key":"spec"}]},"method":"GET"}},"source":"@site/categories/analysis.yaml","sourceDirName":".","permalink":"/badges/cocoapods-doc-percentage","previous":{"title":"ClearlyDefined Score","permalink":"/badges/clearly-defined-score"},"next":{"title":"Codacy grade","permalink":"/badges/codacy-grade"}}');var o=l(74848),i=l(28453);const r={},n="Cocoapods doc percentage",a=[];function c(e){const s={code:"code",h1:"h1",header:"header",p:"p",strong:"strong",...(0,i.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsx)(s.header,{children:(0,o.jsx)(s.h1,{id:"cocoapods-doc-percentage",children:"Cocoapods doc percentage"})}),"\n",(0,o.jsx)(s.p,{children:"Cocoapods doc percentage"}),"\n",(0,o.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,o.jsx)("thead",{children:(0,o.jsx)("tr",{children:(0,o.jsx)("th",{style:{textAlign:"left"},children:"Path Parameters"})})}),(0,o.jsx)("tbody",{children:(0,o.jsx)("tr",{children:(0,o.jsxs)("td",{children:[(0,o.jsx)("code",{children:"spec"}),(0,o.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,o.jsx)("span",{style:{opacity:"0.6"},children:" \u2014 "}),(0,o.jsx)("strong",{style:{fontSize:"var(--ifm-code-font-size)",color:"var(--openapi-required)"},children:" REQUIRED"}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:["Example:\n",(0,o.jsx)("code",{children:"AFNetworking"})]})})]})})})]}),"\n",(0,o.jsxs)("table",{style:{display:"table",width:"100%"},children:[(0,o.jsx)("thead",{children:(0,o.jsx)("tr",{children:(0,o.jsx)("th",{style:{textAlign:"left"},children:"Query Parameters"})})}),(0,o.jsxs)("tbody",{children:[(0,o.jsx)("tr",{children:(0,o.jsxs)("td",{children:[(0,o.jsx)("code",{children:"style"}),(0,o.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:[(0,o.jsx)(s.strong,{children:"Possible values:"})," [",(0,o.jsx)(s.code,{children:"flat"}),", ",(0,o.jsx)(s.code,{children:"flat-square"}),", ",(0,o.jsx)(s.code,{children:"plastic"}),", ",(0,o.jsx)(s.code,{children:"for-the-badge"}),", ",(0,o.jsx)(s.code,{children:"social"}),"]"]})}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsx)(s.p,{children:'If not specified, the default style for this badge is "flat".'})}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:["Example:\n",(0,o.jsx)("code",{children:"flat"})]})})]})}),(0,o.jsx)("tr",{children:(0,o.jsxs)("td",{children:[(0,o.jsx)("code",{children:"logo"}),(0,o.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:["Icon slug from simple-icons. You can click the icon title on ",(0,o.jsx)("a",{href:"https://simpleicons.org/",rel:"noopener noreferrer",target:"_blank",children:"simple-icons"})," to copy the slug or they can be found in the ",(0,o.jsx)("a",{href:"https://github.com/simple-icons/simple-icons/blob/master/slugs.md",children:"slugs.md file"})," in the simple-icons repository. ",(0,o.jsx)("a",{href:"/docs/logos",children:"Further info"}),"."]})}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:["Example:\n",(0,o.jsx)("code",{children:"appveyor"})]})})]})}),(0,o.jsx)("tr",{children:(0,o.jsxs)("td",{children:[(0,o.jsx)("code",{children:"logoColor"}),(0,o.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsx)(s.p,{children:"The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos."})}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:["Example:\n",(0,o.jsx)("code",{children:"violet"})]})})]})}),(0,o.jsx)("tr",{children:(0,o.jsxs)("td",{children:[(0,o.jsx)("code",{children:"logoSize"}),(0,o.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:["Make icons adaptively resize by setting ",(0,o.jsx)(s.code,{children:"auto"}),". Useful for some wider logos like ",(0,o.jsx)(s.code,{children:"amd"})," and ",(0,o.jsx)(s.code,{children:"amg"}),". Supported for simple-icons logos but not for custom logos."]})}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:["Example:\n",(0,o.jsx)("code",{children:"auto"})]})})]})}),(0,o.jsx)("tr",{children:(0,o.jsxs)("td",{children:[(0,o.jsx)("code",{children:"label"}),(0,o.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:["Override the default left-hand-side text (",(0,o.jsx)("a",{href:"https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding",children:"URL-Encoding"})," needed for spaces or special characters!)"]})}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:["Example:\n",(0,o.jsx)("code",{children:"healthiness"})]})})]})}),(0,o.jsx)("tr",{children:(0,o.jsxs)("td",{children:[(0,o.jsx)("code",{children:"labelColor"}),(0,o.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"}

1,children:(0,o.jsx)(s.p,{children:"Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported)."})}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:["Example:\n",(0,o.jsx)("code",{children:"abcdef"})]})})]})}),(0,o.jsx)("tr",{children:(0,o.jsxs)("td",{children:[(0,o.jsx)("code",{children:"color"}),(0,o.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsx)(s.p,{children:"Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported)."})}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:["Example:\n",(0,o.jsx)("code",{children:"fedcba"})]})})]})}),(0,o.jsx)("tr",{children:(0,o.jsxs)("td",{children:[(0,o.jsx)("code",{children:"cacheSeconds"}),(0,o.jsx)("span",{style:{opacity:"0.6"},children:" string"}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsx)(s.p,{children:"HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored)."})}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:["Example:\n",(0,o.jsx)("code",{children:"3600"})]})})]})}),(0,o.jsx)("tr",{children:(0,o.jsxs)("td",{children:[(0,o.jsx)("code",{children:"link"}),(0,o.jsx)("span",{style:{opacity:"0.6"},children:" string[]"}),(0,o.jsx)("div",{style:{marginTop:"var(--ifm-table-cell-padding)"},children:(0,o.jsxs)(s.p,{children:["Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an ",(0,o.jsx)(s.code,{children:"<object>"})," HTML tag, but not an ",(0,o.jsx)(s.code,{children:"<img>"})," tag or a markup language."]})})]})})]})]})]})}function d(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,o.jsx)(s,{...e,children:(0,o.jsx)(c,{...e})}):c(e)}},28453(e,s,l){l.d(s,{R:()=>r,x:()=>n});var t=l(96540);const o={},i=t.createContext(o);function r(e){const s=t.useContext(i);return t.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function n(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(o):e.components||o:r(e.components),t.createElement(i.Provider,{value:s},e.children)}}}]);